1. Anton Karakulov Avatar Anton Karakulov
  2. Untitled project
  3. darudar-backend

Wiki

Clone wiki

darudar-backend / Ресурсы потоков даров

View History

Ресурсы потоков даров

Поток по подпискам

URI: GET ~/flow/subscriptions

Поток по подпискам текущего пользователя.

Пример запроса: 

GET /flow/subscriptions?f=0&s=3 HTTP/1.1
HOST: api.brutto.dev.darudar.com
content-type: application/json
authorization: <token>
accept: application/json

В ответе будет стандартный список даров gifts с дарами по дате их публикации. Пример ответа: 

#!json
{
  "gifts": [
    {...}, <-- Дар (см. вывод дара на списке)
    {...},
    {...}
  ],
  "paginator": {...} <-- см. постраничная навигация
}
Доступна постраничная навигация.

Поиск даров

URI: GET ~/search/gifts

Поиск доступных даров

Параметр Тип Описание
q (обязательный) string Полнотекстовый запрос
city (опциональный) integer ID города
status (опциональный) integer Статус даров

Параметр status может принимать следующие значения:

  • 0 - дарится
  • 1 - обещано
  • 2 - подарено

Пример запроса: 

#!
GET /search/gifts/%D1%88%D1%82%D0%B0%D0%BD%D1%8B%20%D0%BD%D0%B0%20%D0%BB%D1%8F%D0%BC%D0%BA%D0%B0%D1%85 HTTP/1.1
HOST: api.brutto.dev.darudar.com
content-type: application/json
authorization: <token>
accept: application/json

Пример ответа: 

#!json

{
  "gifts": [
    {...}, <-- Дар (см. вывод дара на списке)
    {...}
  ],
  "paginator": {...}, <-- см. постраничный вывод
  "search": { <-- мета по поиску
    "time": 0.011, <-- время затраченное на поиск
    "total_found": 2 <-- общее кол-во похожих объектов (даров etc)
  }
}
Доступна постраничная навигация.

Поток даров "рядом с вами"

URI: GET ~/flow/nearby

Поток даров "рядом с вами" на основе переданных параметров, или настроек пользователя.

Пример запроса: 

GET /flow/nearby HTTP/1.1
HOST: api.brutto.dev.darudar.com
content-type: application/json
authorization: <token>
accept: application/json

На данный момент реализована работа только через настройки, при передаче параметров возвращается ошибка 501.

В ответе будет стандартный список даров gifts с дарами по дате их публикации. Пример ответа: 

#!json
{
  "gifts": [
    {...}, <-- Дар (см. вывод дара на списке)
    {...},
    {...}
  ],
  "paginator": {...} <-- см. постраничная навигация
}
Доступна постраничная навигация.

Updated